﻿
namespace Com.FastSearch.SharePoint.Interfaces
{
    /// <summary>
    /// Interface for building queries based on text entered by the user, and query
    /// templates configured by site administrators.
    /// </summary>
    public interface IQueryBuilder
    {
        /// <summary>
        /// Build a query that can be submitted to a search engine based on the user
        /// query and given template. Should replace the parameter {0} with the query
        /// string and {1} with "user".
        /// </summary>
        /// <param name="UserQuery">the text entered by the user</param>
        /// <param name="QueryTemplate">the query template</param>
        /// <returns>a query that can be submitted</returns>
        string BuildQueryStringFromTemplate(string UserQuery, string QueryTemplate);
    }
}
